/*
 * Copyright 2008 the Breachwalls OSS project and the Others.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package com.breachwalls.quasar.datatype.converter;

import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;

import com.breachwalls.quasar.datatype.Datatype;

/**
 * データタイプコンバータ.
 * @author todoken
 * @version $Revision$
 */
public interface DatatypeConverter {

    /**
     * データタイプコンバータが変換しようとしているデータタイプのクラスを取得する.
     * @return 変換するデータタイプのクラス
     */
    Class<?> getConvertedClass();

    /**
     * データタイプをデータベースに保存する時のSQLタイプを取得する.
     * @return データベースに保存する時のSQLタイプ
     */
    int[] getSqlTypes();

    /**
     * データベースから読み込んだ値をデータタイプに変換する.
     * @param rs リザルトセット
     * @param name SQL実行時の項目名称
     * @return SQL実行結果をデータタイプに変換した結果
     * @throws SQLException リザルトセットから値を取得する際に発生する例外
     */
    Datatype nullSafeGet(ResultSet rs, String name) throws SQLException;

    /**
     * ステートメントにデータタイプの値をセットする.
     * @param st プリペアステートメント
     * @param value ステートメントにセットする値
     * @param index プリペアステートメントに設定する順番
     * @throws SQLException ステートメントに値を設定する際に発生する例外
     */
    void nullSafeSet(PreparedStatement st, Object value, int index) throws SQLException;

}
